Facility Navigation Bar Tool – Properties
The following table describes the Facility Navigation Bar Tool properties available through the Property Sheet and the script editor. Many of these properties are also available on the (OCXProperties) property sheets. A property name may vary, depending on where it appears.
Note: If a property or method in the script editor has two forms with the same name, one form exists for legacy support and the other form is current. When possible, use the current form. To select the current form, append .X. to the name of the object to which the property or method applies, and then enter the property or method name. For instance, enter MyObject.X.MyProperty. If a property or method in the script editor has only one form, the X method might or might not apply. The .png "X method")
column in the table below indicates whether or not a property or method is accessible using the X method.
Browse by letter: [A] [B] [C] [D] [E] [F] [G] [H] [I] [L] [O] [R] [S] [T] [V] [W]
| Property Sheet | Script Editor |
|
Description |
|---|---|---|---|
|
AllowAllValues |
Yes |
If Allow All Values is selected, the All option appears for the level and all attribute values available in the child level are displayed. Otherwise, only attribute values filtered by a parent level are displayed. Use (1 - Yes) to enable. |
|
|
AllowBlankValues |
Yes |
If Allow Blank Values is selected, the Not Specified option appears for the level and facilities can be displayed if no attribute value is specified. Use (1 - Yes) to enable. |
|
|
AutoRestart |
No |
[AutoRestart] specifies whether TheView automatically restarts when a user changes a Facility Navigation Bar object, a Group Grid object, or a Group Navigation Bar object. [AutoRestart] is typically used to reset the Facility ID of TheView for templated objects. It is not required to reset the contents in a Group Grid object. When used with a Facility Navigation Bar or a Group Navigation Bar, the [Facility] property of TheView is set to match the facility selected in the drop-down menu. When used with a Group Grid object, the [Facility] property of TheView changes to match the Group Grid row when the row is clicked. Use (1 - Yes) to enable. The default is 0 - No. |
|
|
AutoSizeFont |
No |
AutoSizeFont specifies whether the object’s font is automatically resized: Shrink to Fit and Expand to Fit resize the font in Edit mode so that the text fits the boundary of the object. You can use these options to resize the font without using the object’s Font property to explicitly set the font size. In Run mode, the font is dynamically resized in Run mode to accommodate the [DisplayItem] or the tokens specified by the Text property.
Proportional and Proportional Fit resize the font in Run mode based on resizing of TheView.
Note: An object can be resized in Run mode only if its FlexHorizontal and FlexVertical properties are set to 2 — Expand or 3 — Proportional. Available AutoSizeFont options are 1 — Shrink to Fit, 2 — Expand to Fit, 3 — Best Fit, 4 — Proportional, and 5 — Proportional Fit. The default is 0 — No (no font resizing). |
|
|
BackColor |
Yes |
BackColor selects a background color for the Facility Navigation BarTool. |
|
|
BorderStyle |
Yes |
BorderStyle specifies the border style of the Facility Navigation Bar windows. Available values are:
|
|
|
Bottom |
No |
Bottom specifies the distance (in pixels) from the top of TheView’s scroll region to the bottom of the object. You can dynamically change this value in Edit mode if you use the mouse to enlarge or shrink the object. See Sizing and Positioning Objects. |
|
|
CursorPointer |
No |
For TheView, CursorPointer selects the cursor icon that appears when you mouse over objects. For objects, CursorPointer selects the cursor icon for the instance of the object. The object’s cursor pointer takes precedence over TheView’s cursor pointer. The default is 0 — Default. For TheView, this is an arrow. For other objects, the icon configured for TheView is used. Other options are:
Script subtype is long. |
|
|
No |
DisplayFont returns the current, resized font values for the object. The correct font size is returned only if AutoSizeFont is enabled. For tools other than Text Tool, DDS Editor Button, SetPoint Button, and UIS Command Button DisplayFont is identical to the Font property, except that this is a font interface object instead of a string. This property is read only. |
||
|
Enable |
No |
Enable specifies whether the user is able to interact with the object. Options are 0 — No and 1 — Yes. The default is 1 — Yes. If set to 0 — No, the object is still visible but its context menu is disabled. Other options:
|
|
| FacNavBarAttributesDescriptions | FacNavBarAttributesDescriptions | Yes |
Specifies the user descriptions of Facility Navigation Bar attributes. |
|
FacNavBarAttributesValues |
Yes |
Specifies the values of Facility Navigation Bar attributes. |
|
|
N/A |
No |
FlexHorizontal specifies whether the object moves or resizes horizontally or is unchanged when TheFrame is resized. Options are:
Default is 0 — None. |
|
|
N/A |
No |
FlexVertical specifies whether the object moves or resizes vertically when TheFrame is resized. Options are:
Default is 0 — None. |
|
|
Font |
Yes |
Font specifies the font for the object. For TheView, this property specifies the default font for text-based objects. For other objects, it specifies the font for the instance of the object. The object’s font takes precedence over the font set for TheView. Click … to view the Font dialog box, which you can use to configure the font. The default is MS Shell Dlg (MS Sans Serif, regular, 8 pt). Script subtype is string. Note: In script, you can set font properties using "-13, Arial" for example. |
|
|
N/A |
No |
ForeColor specifies the foreground color for the object. The default is Automatic, which, for most objects is black. Note that if the object’s [AlarmElement] is set to Foreground Color and a primary point has been assigned to the object, the foreground color will change in Run mode to reflect the point status. Note: In script, you can set this and other color properties using the VBScript function 'control.somecolor = RGB (255,0,0).' |
|
|
Group |
No |
Group groups objects into a discrete sequence that can be navigated using the arrow keys. Options are 0 — No and 1 — Yes. The default is 0 — No. To use this property: 1. Add objects that use the Group property to a screen. 2. Position them as you like (typically in a spatial configuration that reflects the order in which they were added to the screen). 3. Decide where in the spatial configuration logical groups begin and end. 4. Mark the beginning of a group by setting the Group property to 1 — Yes for the first object in the group. 5. Set Group set to 0 — No for other objects in the group. The group is made up of all objects that 1) are added sequentially after an object with a Group property set to 1 — Yes and 2) that use a Group property set to 0 — No. A group's arrow navigation sequence reflects the order in which its objects were added to a screen. This property is not related to the Draw > Group option in the CygNet Studio menu bar. This property might not be suited for use with all tools that include the Group property. Script subtype is long. See also Tabstop. |
|
|
N/A |
No |
Specifies the GroupID of the object group. |
|
|
No |
Returns a Boolean value to confirm a CygNet-aware tool is associated with a valid CygNet tag. This property may not be suited for use with all tools that include the HasValidTag property. See also CygNet-Aware Tools. Script subtype is Boolean. |
||
|
HelpContextID |
No |
HelpContextID specifies the object’s help identifier for context-sensitive help. TheFrame’s WhatsThisHelp must be enabled. Script subtype is long. |
|
|
No |
Initial Filter defines a subset of facilities. If you are defining multiple levels, the Initial Filter is level 0, the leftmost drop-down level in the Facility Navigation Bar Tool. Additional filtering will begin with the level 0 filter. |
||
|
InitialFilterRules |
Yes |
Specifies the facility Initial Rule filter. |
|
|
N/A |
No |
Returns a Boolean value that confirms that an object is a CygNet-aware tool. This property might not be suited for use with all tools that include the IsCygNetAware property. Script subtype is Boolean. See also CygNet-Aware Tools. |
|
|
Yes |
Specifies the label attribute for a specified level as an integer.
|
||
|
N/A |
Yes |
Specifies the label attribute of a specified level as a string.
|
|
|
N/A |
Yes |
Specifies the label text for a specified level.
|
|
|
N/A |
Yes |
Specifies the label type for a specified level. The property can be 1 — Attribute or 2 — Text.
|
|
|
LayerID |
No |
Layer identifies the layer on which the object resides. Script subtype is Boolean. |
|
|
Left |
No |
Left specifies the distance (in pixels) from the left edge of TheView’s scroll region to the left edge of the object. See Sizing and Positioning Objects. |
|
|
Levels |
Yes |
Specifies the total number of drop-down levels in the tool. The default is 3. |
|
|
No |
(ObjectCode) specifies a unique identifier of the object. You can enter up to 39 characters. Valid characters are A-Z, 0-9, and underscore (_). Spaces are not allowed. The default is the object name and the numeric instance. Script subtype is string. |
||
|
N/A |
No |
Displays the OCXProperty dialog box unique to the object. |
|
|
Right |
No |
Right specifies the distance (in pixels) from the left edge of TheView’s scroll region to the right edge of the object. See Sizing and Positioning Objects. |
|
|
N/A |
No |
Causes the object to rotate clockwise the specified number of degrees. You can rotate an object directly by using the Rotate option on the Draw menu. For details, see Rotating an Object. |
|
|
RuntimeCfgAutoPersist |
Yes |
Specifies whether runtime settings applied using script automatically persist between Facility Navigation Bar loads. Default is 0 — No. |
|
|
RuntimeCfgPersistName |
Yes |
Specifies the registry key to be used for persisting runtime settings. The default is DefaultRuntimeCfg. |
|
|
SelectionsPersistName |
Yes |
Specifies the registry key to which a runtime selection (target) is written for persistence. The default is DefaultSelections. Note: This property can be used to synchronize Facility Navigation Bars from screen to screen. This only works when screens are closed and reopened (unless you add a Refresh button to TheView to refresh the screen). |
|
|
ShowDescriptions |
Yes |
Specifies whether descriptions (rather than table entry names) are shown for table facility attributes. Notes: When this property is set, two parameters are required: an integer that specifies the level for the property and a Boolean value to set (for example, FacNavBar.X.ShowDescriptions 0, True). When this property is retrieved, one parameter is required: an integer that specifies the level for retrieving the property (for example, MsgBox FacNavBar.X.ShowDescriptions(0)). |
|
|
ShowLabels |
Yes |
Specifies whether labels appear above the drop-down menus. Default is 1 — Yes. |
|
|
ShowTargetLevel |
Yes |
If Levels is selected, the last drop-down menu in the Facility or Group Navigation Bar contains a list of facilities or leaf nodes based on the last level. Otherwise, the last drop-down shows the last level in the hierarchy. |
|
|
SiteService |
Yes |
[SiteService] identifies the CVS, Facility Service, or Group Service for the settings. The format for the value is Site.Service. If this field is blank, the Site.Service specified for TheView is used. If Site.Service is defined for both TheView and the object, the value specified for the object is used. The script subtype is string. |
|
|
No |
Tabstop specifies whether the focus stops on the object when you use the Tab key to navigate between objects (in other words, enables the object as a tab stop). Options are 0 — No and 1 — Yes. Default is 1 — Yes. Script subtype is long. Note: To set the tab order, use the Objects option on the Layout menu. |
||
|
Tag |
No |
Tag is an extra field for application-specific purposes. Does not specify a CygNet point. Default is blank. Script subtype is string. |
|
|
N/A |
Yes |
Returns the number of the target level of the filter hierarchy. |
|
|
ToolTipText |
No |
TooltipText identifies text that is displayed when the mouse hovers over the object in Run mode. For some objects, tooltip text can be dynamic, static, or a combination. You build dynamic text with tokens that can represent point configuration, facility, and CVS point record properties. You can also specify data formatting. Click … to view the Edit Tooltip Text dialog box you use to configure the text. For information about building dynamic text using tokens, see Using Text Tokens. Script subtype is string. Note: Although this property is listed on the Property Sheet and in the Script Editor for many tools, it is not supported by all. For example, the Facility Navigation Bar, the Group Grid, and the Group Navigation Bar do not support this property. |
|
|
N/A |
No |
Returns a CygNet-defined string value that describes the object type. This value appears in the Status Bar when you hover over a default control in its tool palette. You can also display the value using a script. This property is read only. See also Rule-Based Substitution. Script subtype is string. |
|
|
Top |
No |
Top specifies the distance (in pixels) from the top of TheView’s scroll region to the top of the object. See Sizing and Positioning Objects. |
|
|
Visible |
No |
Visible secifies whether the object is visible in Run mode. Options are 0 — No or 1 — Yes. Default is 1 — Yes. Note: Objects are always visible in Edit mode, regardless of how this property value is set. You can also:
|
|
|
Yes |
Specifies the width of the combo box at the specified filter level.
|
||
|
N/A |
Yes |
Specifies the width type of a specified level. Options are 1 — Variable or 2 — Fixed.
|
